<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
<meta name="generator" content="pdoc 0.10.0" />
<title>py3dtilers.CityTiler.database_accesses_batch_table_hierarchy API documentation</title>
<meta name="description" content="" />
<link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/sanitize.min.css" integrity="sha256-PK9q560IAAa6WVRRh76LtCaI8pjTJ2z11v0miyNNjrs=" crossorigin>
<link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/typography.min.css" integrity="sha256-7l/o7C8jubJiy74VsKTidCy1yBkRtiUGbVkYBylBqUg=" crossorigin>
<link rel="stylesheet preload" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/styles/github.min.css" crossorigin>
<style>:root{--highlight-color:#fe9}.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}#sidebar > *:last-child{margin-bottom:2cm}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}h1:target,h2:target,h3:target,h4:target,h5:target,h6:target{background:var(--highlight-color);padding:.2em 0}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{margin-top:.6em;font-weight:bold}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}dt:target .name{background:var(--highlight-color)}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}td{padding:0 .5em}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%;height:100vh;overflow:auto;position:sticky;top:0}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
<script defer src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/highlight.min.js" integrity="sha256-Uv3H6lx7dJmRfRvH8TH6kJD1TSK1aFcwgx+mdg3epi8=" crossorigin></script>
<script>window.addEventListener('DOMContentLoaded', () => hljs.initHighlighting())</script>
</head>
<body>
<main>
<article id="content">
<header>
<h1 class="title">Module <code>py3dtilers.CityTiler.database_accesses_batch_table_hierarchy</code></h1>
</header>
<section id="section-intro">
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">import itertools

from py3dtiles import BatchTableHierarchy
from ..Common import TreeWithChildrenAndParent


def retrieve_buildings_and_sub_parts(cursor, buildingIds, classes, hierarchy):
    &#34;&#34;&#34;
    :type classes: new classes are appended
    &#34;&#34;&#34;
    # ##### Walk on the building and
    #   - collect buildings&#39;: id, glm-id and class
    #   - collect the names of used classes (i.e. the types of user data)
    #   - collect the hierarchical information
    buildindsAndSubParts = []

    cursor.execute(
        &#34;SELECT building.id, building_parent_id,&#34;
        &#34;       cityobject.gmlid, cityobject.objectclass_id &#34;
        &#34;FROM citydb.building JOIN citydb.cityobject ON building.id=cityobject.id &#34;
        &#34;                        WHERE building_root_id IN &#34; + buildingIds)
    for t in cursor.fetchall():
        buildindsAndSubParts.append(
            {&#39;internalId&#39;: t[0], &#39;gmlid&#39;: t[2], &#39;class&#39;: t[3]})
        hierarchy.addNodeToParent(t[0], t[1])
        # Note: set.add() does nothing when the added element is already
        # present in the set
        classes.add(t[3])
    return buildindsAndSubParts


def retrieve_geometric_instances(cursor, buildingIds, classes, hierarchy):
    &#34;&#34;&#34;
    :type classes: new classes are appended
    &#34;&#34;&#34;
    # ##### Collect the same information as for buildings but this time
    # for surface geometries (geometrical object) that is
    #   - collect surface geometries&#39;: id, glm-id and class
    #   - collect the names of used classes (i.e. the types of user data)
    #   - collect the hierarchical information

    # First retrieve all the concerned (geometrical) objects identifiers:
    # 3DCityDB&#39;s Building table regroups both the buildings mixed with their
    # building&#39;s sub-divisions (Building is an &#34;abstraction&#34; from which
    # inherits concrete building class as well building-subdivisions (parts).
    # We must first collect all the buildings and their parts:
    cursor.execute(
        &#34;SELECT building.id &#34;
        &#34;FROM citydb.building JOIN citydb.cityobject ON building.id=cityobject.id &#34;
        &#34;                        WHERE building_root_id IN &#34; + buildingIds)

    subBuildingIds = tuple([t[0] for t in cursor.fetchall()])

    # Then proceed with collecting the required information for those objects:
    geometricInstances = []
    cursor.execute(
        &#34;SELECT cityobject.id, cityobject.gmlid, &#34;
        &#34;       thematic_surface.building_id, thematic_surface.objectclass_id, &#34;
        &#34;ST_AsBinary(ST_Multi(ST_Collect(surface_geometry.geometry))) &#34;
        &#34;FROM citydb.surface_geometry JOIN citydb.thematic_surface &#34;
        &#34;ON surface_geometry.root_id=thematic_surface.lod2_multi_surface_id &#34;
        &#34;JOIN citydb.cityobject ON thematic_surface.id=cityobject.id &#34;
        &#34;WHERE thematic_surface.building_id IN %s &#34;
        &#34;GROUP BY surface_geometry.root_id, cityobject.id, cityobject.gmlid, &#34;
        &#34;        thematic_surface.building_id, thematic_surface.objectclass_id&#34;,
        (subBuildingIds,))
    # In the above request we won&#39;t collect the geometry. However we still
    # retrieve it in order to disregard the instances without geometry. This
    # is because
    #   - we need the BTH data indexes to match the geometrical data indexes
    #   - when building (verb) the gltf (held in the B3dm) geometries we
    #     had to drop instances without geometrical content...
    for t in cursor.fetchall():
        if t[4] is None:
            # Some thematic surface may have no geometry (due to a cityGML
            # exporter bug?): simply ignore them.
            continue
        geometricInstances.append(
            {&#39;internalId&#39;: t[0], &#39;gmlid&#39;: t[1], &#39;class&#39;: t[3]})
        hierarchy.addNodeToParent(t[0], t[2])
        classes.add(t[3])

    return geometricInstances


def create_batch_table_hierarchy(cursor, buildingIds):
    &#34;&#34;&#34;
    :rtype: a TileContent in the form a B3dm.
    &#34;&#34;&#34;

    resulting_bth = BatchTableHierarchy()

    # The constructed BatchTableHierarchy encodes the semantics of two
    # categories of objects:
    #  - non geometrical objects (building header gathering sub-buildings...)
    #  - the geometrical objects per se
    # We collect the information associated to those two categories separately:
    classes = set()
    hierarchy = TreeWithChildrenAndParent()
    buildindsAndSubParts = retrieve_buildings_and_sub_parts(cursor,
                                                            buildingIds,
                                                            classes,
                                                            hierarchy)
    geometricInstances = retrieve_geometric_instances(cursor,
                                                      buildingIds,
                                                      classes,
                                                      hierarchy)

    # ##### Retrieve the class names
    classDict = {}
    cursor.execute(&#34;SELECT id, classname FROM citydb.objectclass&#34;)
    for t in cursor.fetchall():
        # TODO: allow custom fields to be added (here + in queries)
        classDict[t[0]] = (t[1], [&#39;gmlid&#39;])

    # ###### All the upstream information is now retrieved from the DataBase
    # and we can proceed with the construction of the BTH

    # Within the BTH, create each required classes (as types)
    for c in classes:
        resulting_bth.add_class(classDict[c][0], classDict[c][1])

    # Build the positioning index within the constructed BatchTableHierarchy
    objectPosition = {}
    for i, (obj) in enumerate(itertools.chain(geometricInstances,
                                              buildindsAndSubParts)):
        object_id = obj[&#39;internalId&#39;]
        objectPosition[object_id] = i

    # Eventually insert objects (with geometries and without geometry)
    # associated (semantic) information. Notice that each type of object
    # (with geometries and without geometry) has its respective class
    # attributes)
    for obj in itertools.chain(geometricInstances,
                               buildindsAndSubParts):
        object_id = obj[&#39;internalId&#39;]
        resulting_bth.add_class_instance(
            classDict[obj[&#39;class&#39;]][0],
            obj,
            [objectPosition[id] for id in hierarchy.getParents(object_id)])

    return resulting_bth</code></pre>
</details>
</section>
<section>
</section>
<section>
</section>
<section>
<h2 class="section-title" id="header-functions">Functions</h2>
<dl>
<dt id="py3dtilers.CityTiler.database_accesses_batch_table_hierarchy.create_batch_table_hierarchy"><code class="name flex">
<span>def <span class="ident">create_batch_table_hierarchy</span></span>(<span>cursor, buildingIds)</span>
</code></dt>
<dd>
<div class="desc"><p>:rtype: a TileContent in the form a B3dm.</p></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def create_batch_table_hierarchy(cursor, buildingIds):
    &#34;&#34;&#34;
    :rtype: a TileContent in the form a B3dm.
    &#34;&#34;&#34;

    resulting_bth = BatchTableHierarchy()

    # The constructed BatchTableHierarchy encodes the semantics of two
    # categories of objects:
    #  - non geometrical objects (building header gathering sub-buildings...)
    #  - the geometrical objects per se
    # We collect the information associated to those two categories separately:
    classes = set()
    hierarchy = TreeWithChildrenAndParent()
    buildindsAndSubParts = retrieve_buildings_and_sub_parts(cursor,
                                                            buildingIds,
                                                            classes,
                                                            hierarchy)
    geometricInstances = retrieve_geometric_instances(cursor,
                                                      buildingIds,
                                                      classes,
                                                      hierarchy)

    # ##### Retrieve the class names
    classDict = {}
    cursor.execute(&#34;SELECT id, classname FROM citydb.objectclass&#34;)
    for t in cursor.fetchall():
        # TODO: allow custom fields to be added (here + in queries)
        classDict[t[0]] = (t[1], [&#39;gmlid&#39;])

    # ###### All the upstream information is now retrieved from the DataBase
    # and we can proceed with the construction of the BTH

    # Within the BTH, create each required classes (as types)
    for c in classes:
        resulting_bth.add_class(classDict[c][0], classDict[c][1])

    # Build the positioning index within the constructed BatchTableHierarchy
    objectPosition = {}
    for i, (obj) in enumerate(itertools.chain(geometricInstances,
                                              buildindsAndSubParts)):
        object_id = obj[&#39;internalId&#39;]
        objectPosition[object_id] = i

    # Eventually insert objects (with geometries and without geometry)
    # associated (semantic) information. Notice that each type of object
    # (with geometries and without geometry) has its respective class
    # attributes)
    for obj in itertools.chain(geometricInstances,
                               buildindsAndSubParts):
        object_id = obj[&#39;internalId&#39;]
        resulting_bth.add_class_instance(
            classDict[obj[&#39;class&#39;]][0],
            obj,
            [objectPosition[id] for id in hierarchy.getParents(object_id)])

    return resulting_bth</code></pre>
</details>
</dd>
<dt id="py3dtilers.CityTiler.database_accesses_batch_table_hierarchy.retrieve_buildings_and_sub_parts"><code class="name flex">
<span>def <span class="ident">retrieve_buildings_and_sub_parts</span></span>(<span>cursor, buildingIds, classes, hierarchy)</span>
</code></dt>
<dd>
<div class="desc"><p>:type classes: new classes are appended</p></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def retrieve_buildings_and_sub_parts(cursor, buildingIds, classes, hierarchy):
    &#34;&#34;&#34;
    :type classes: new classes are appended
    &#34;&#34;&#34;
    # ##### Walk on the building and
    #   - collect buildings&#39;: id, glm-id and class
    #   - collect the names of used classes (i.e. the types of user data)
    #   - collect the hierarchical information
    buildindsAndSubParts = []

    cursor.execute(
        &#34;SELECT building.id, building_parent_id,&#34;
        &#34;       cityobject.gmlid, cityobject.objectclass_id &#34;
        &#34;FROM citydb.building JOIN citydb.cityobject ON building.id=cityobject.id &#34;
        &#34;                        WHERE building_root_id IN &#34; + buildingIds)
    for t in cursor.fetchall():
        buildindsAndSubParts.append(
            {&#39;internalId&#39;: t[0], &#39;gmlid&#39;: t[2], &#39;class&#39;: t[3]})
        hierarchy.addNodeToParent(t[0], t[1])
        # Note: set.add() does nothing when the added element is already
        # present in the set
        classes.add(t[3])
    return buildindsAndSubParts</code></pre>
</details>
</dd>
<dt id="py3dtilers.CityTiler.database_accesses_batch_table_hierarchy.retrieve_geometric_instances"><code class="name flex">
<span>def <span class="ident">retrieve_geometric_instances</span></span>(<span>cursor, buildingIds, classes, hierarchy)</span>
</code></dt>
<dd>
<div class="desc"><p>:type classes: new classes are appended</p></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def retrieve_geometric_instances(cursor, buildingIds, classes, hierarchy):
    &#34;&#34;&#34;
    :type classes: new classes are appended
    &#34;&#34;&#34;
    # ##### Collect the same information as for buildings but this time
    # for surface geometries (geometrical object) that is
    #   - collect surface geometries&#39;: id, glm-id and class
    #   - collect the names of used classes (i.e. the types of user data)
    #   - collect the hierarchical information

    # First retrieve all the concerned (geometrical) objects identifiers:
    # 3DCityDB&#39;s Building table regroups both the buildings mixed with their
    # building&#39;s sub-divisions (Building is an &#34;abstraction&#34; from which
    # inherits concrete building class as well building-subdivisions (parts).
    # We must first collect all the buildings and their parts:
    cursor.execute(
        &#34;SELECT building.id &#34;
        &#34;FROM citydb.building JOIN citydb.cityobject ON building.id=cityobject.id &#34;
        &#34;                        WHERE building_root_id IN &#34; + buildingIds)

    subBuildingIds = tuple([t[0] for t in cursor.fetchall()])

    # Then proceed with collecting the required information for those objects:
    geometricInstances = []
    cursor.execute(
        &#34;SELECT cityobject.id, cityobject.gmlid, &#34;
        &#34;       thematic_surface.building_id, thematic_surface.objectclass_id, &#34;
        &#34;ST_AsBinary(ST_Multi(ST_Collect(surface_geometry.geometry))) &#34;
        &#34;FROM citydb.surface_geometry JOIN citydb.thematic_surface &#34;
        &#34;ON surface_geometry.root_id=thematic_surface.lod2_multi_surface_id &#34;
        &#34;JOIN citydb.cityobject ON thematic_surface.id=cityobject.id &#34;
        &#34;WHERE thematic_surface.building_id IN %s &#34;
        &#34;GROUP BY surface_geometry.root_id, cityobject.id, cityobject.gmlid, &#34;
        &#34;        thematic_surface.building_id, thematic_surface.objectclass_id&#34;,
        (subBuildingIds,))
    # In the above request we won&#39;t collect the geometry. However we still
    # retrieve it in order to disregard the instances without geometry. This
    # is because
    #   - we need the BTH data indexes to match the geometrical data indexes
    #   - when building (verb) the gltf (held in the B3dm) geometries we
    #     had to drop instances without geometrical content...
    for t in cursor.fetchall():
        if t[4] is None:
            # Some thematic surface may have no geometry (due to a cityGML
            # exporter bug?): simply ignore them.
            continue
        geometricInstances.append(
            {&#39;internalId&#39;: t[0], &#39;gmlid&#39;: t[1], &#39;class&#39;: t[3]})
        hierarchy.addNodeToParent(t[0], t[2])
        classes.add(t[3])

    return geometricInstances</code></pre>
</details>
</dd>
</dl>
</section>
<section>
</section>
</article>
<nav id="sidebar">
<h1>Index</h1>
<div class="toc">
<ul></ul>
</div>
<ul id="index">
<li><h3>Super-module</h3>
<ul>
<li><code><a title="py3dtilers.CityTiler" href="index.html">py3dtilers.CityTiler</a></code></li>
</ul>
</li>
<li><h3><a href="#header-functions">Functions</a></h3>
<ul class="">
<li><code><a title="py3dtilers.CityTiler.database_accesses_batch_table_hierarchy.create_batch_table_hierarchy" href="#py3dtilers.CityTiler.database_accesses_batch_table_hierarchy.create_batch_table_hierarchy">create_batch_table_hierarchy</a></code></li>
<li><code><a title="py3dtilers.CityTiler.database_accesses_batch_table_hierarchy.retrieve_buildings_and_sub_parts" href="#py3dtilers.CityTiler.database_accesses_batch_table_hierarchy.retrieve_buildings_and_sub_parts">retrieve_buildings_and_sub_parts</a></code></li>
<li><code><a title="py3dtilers.CityTiler.database_accesses_batch_table_hierarchy.retrieve_geometric_instances" href="#py3dtilers.CityTiler.database_accesses_batch_table_hierarchy.retrieve_geometric_instances">retrieve_geometric_instances</a></code></li>
</ul>
</li>
</ul>
</nav>
</main>
<footer id="footer">
<p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.10.0</a>.</p>
</footer>
</body>
</html>